UpdateAdditionalInfo

This operation transfers additional information uploaded by the applicant from ePlanning to the relevant organisation's IT system. This additional information could either be provided voluntarily by the applicant or as the result of a request from the relevant organisation.

path Parameters
CaseID
required
string

A fully qualified application number

header Parameters
OrganisationID
required
string

Used by the API gateway to route the request to the relevant organisation.

IdempotencyId
required
string

Unique Id for this request. Allows the API to respond in an idempotent way if it has already been called with these parameters and prevents duplicate processing. Typically a UUID such as "63a9ba30-7a4b-4fac-b343-d1f05cf089f1"

Request Body schema: application/json

Information request object

caseStatus
required
string [ 1 .. 100 ] characters

This field is to track the case status of the additional information request

childCaseID
string

This child case ID is to track the additional information request.

responseDate
required
string <date> non-empty

This is to track the date on which additional information is provided.

responseDetails
string

Additional information description provided by the applicant

Array of objects (DownloadableDocument)
object (UpdatedBy)

Responses

Request samples

Content type
application/json
{
  • "caseStatus": "Complete",
  • "childCaseID": "string",
  • "responseDate": "2019-08-24",
  • "responseDetails": "string",
  • "documents": [
    ],
  • "updatedBy": {
    }
}

Response samples

Content type
application/json
{
  • "statusCode": 404,
  • "message": "Internal Server error 19876",
  • "activityId": "00000011-0ab-xy00-0000-500000000000",
  • "errorCode": "DPE_TMS01",
  • "errorDetails": "Inner Exceptions, Stack Trace, etc"
}
Next to Reassign